<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: util/detail/util.cpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;1.0.2</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_a762a7cb84c76c9561dbc78c61068184.html">util</a></li><li class="navelem"><a class="el" href="dir_b5fa8338842f1288129dabc4bfd9a8d3.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">util.cpp</div></div>
</div><!--header-->
<div class="contents">
<a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Core</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#include &quot;<a class="code" href="detail_2util__fwd_8hpp.html">ipc/util/detail/util_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="preprocessor">#include &quot;<a class="code" href="shared__name_8hpp.html">ipc/util/shared_name.hpp</a>&quot;</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &lt;flow/error/error.hpp&gt;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &lt;flow/common.hpp&gt;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &lt;boost/interprocess/managed_shared_memory.hpp&gt;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &lt;boost/array.hpp&gt;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span> </div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1util.html">ipc::util</a></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span>{</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span> </div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment">// Initializers.</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment">// Read the doc headers to understand why the numeric values below were chosen.</span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="keyword">const</span> boost::array&lt;<a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>, size_t(<a class="code hl_enumvalue" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf">Permissions_level::S_END_SENTINEL</a>)&gt;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#a5716a13eb4de32e516ca257e025d8c20">   33</a></span>  <a class="code hl_variable" href="namespaceipc_1_1util.html#a5716a13eb4de32e516ca257e025d8c20">SHARED_RESOURCE_PERMISSIONS_LVL_MAP</a></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span>    = {</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span>        <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>(0), <span class="comment">// &lt;= NO_ACCESS</span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span>        <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>(0b110000000), <span class="comment">// &lt;= USER_ACCESS.  Value a/k/a 0600.</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span>        <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>(0b110110000), <span class="comment">// &lt;= GROUP_ACCESS.  Value a/k/a 660.</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span>        <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>(0b110110110) <span class="comment">// &lt;= UNRESTRICTED.  Value a/k/a 666.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span>      };</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="keyword">const</span> boost::array&lt;<a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>, size_t(<a class="code hl_enumvalue" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf">Permissions_level::S_END_SENTINEL</a>)&gt;</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#aa74a8b46a5b38021c662a0b3bdfb46bf">   41</a></span>  <a class="code hl_variable" href="namespaceipc_1_1util.html#aa74a8b46a5b38021c662a0b3bdfb46bf">PRODUCER_CONSUMER_RESOURCE_PERMISSIONS_LVL_MAP</a></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span>    = {</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span>        <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>(0), <span class="comment">// &lt;= NO_ACCESS</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span>        <span class="comment">/* Note: creator must be able to write, so no choice but to allow any app running-as that user to write.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment">         * Typically some trust is required that the consumer apps won&#39;t use this ability to, in fact, write. */</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span>        <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>(0b110000000), <span class="comment">// &lt;= USER_ACCESS.  Value a/k/a 0600.</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span>        <span class="comment">// Other users can read.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span>        <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>(0b110100000), <span class="comment">// &lt;= GROUP_ACCESS.  Value a/k/a 0640.</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span>        <a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>(0b110100100) <span class="comment">// &lt;= UNRESTRICTED.  Value a/k/a 0644.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span>      };</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"></span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment">/**</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * Maps general Permissions_level specifier to low-level #Permissions value, when the underlying resource</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * is in the file-system (e.g., a file) and is *produced* (and therefore always writable) by the owning (creating,</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * updating) user; but *consumed* (and therefore at most readable, never writable) by potentially other processes,</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * and therefore possibly other users (e.g., group access or unrestricted access -- but only for reading either way).</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * For example a PID file is typically only writable by the daemon&#39;s user but may be readable or inaccessible by</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> * other users.</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> */</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="keyword">extern</span> <span class="keyword">const</span> boost::array&lt;<a class="code hl_typedef" href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">Permissions</a>, size_t(<a class="code hl_enumvalue" href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf">Permissions_level::S_END_SENTINEL</a>)&gt;</div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span>  <a class="code hl_variable" href="namespaceipc_1_1util.html#aa74a8b46a5b38021c662a0b3bdfb46bf">PRODUCER_CONSUMER_RESOURCE_PERMISSIONS_LVL_MAP</a>;</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span> </div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#aaaa1fe31f8d77f78345dec8fc95e9882">   63</a></span><span class="keyword">const</span> fs::path <a class="code hl_variable" href="namespaceipc_1_1util.html#aaaa1fe31f8d77f78345dec8fc95e9882">IPC_KERNEL_PERSISTENT_RUN_DIR</a> = <span class="stringliteral">&quot;/var/run&quot;</span>;</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span> </div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment">// Implementations.</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span> </div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#a5429c6225cc9a271ad8c0041d99c236b">   67</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a5429c6225cc9a271ad8c0041d99c236b">pipe_produce</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc_1_1util.html#a844d5ca9c17b672644fc8d9dbe758db0">Pipe_writer</a>* pipe)</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>{</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>  <span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">util::Blob_const</a>;</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>  <span class="comment">/* As promised, we will block if the pipe is full.</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">   *</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">   * @todo It would still be nicer if we made pipe non-blocking and detected would-block here and at least</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">   * assert()ed in that case.  However their boost::asio::*able_pipe doesn&#39;t expose such a method</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">   * (in contrast to various sockets)... which is a bit odd/annoying actually.  We could use ::fcntl() but...</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">   * anyway, that&#39;s the to-do.  Actually we could perhaps use async_write_some() with, like, a timeout...</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">   * or something.... */</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>  <span class="keyword">const</span> uint8_t PAYLOAD = <span class="charliteral">&#39;\0&#39;</span>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> sys_err_code;</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> ok = pipe-&gt;write_some(<a class="code hl_typedef" href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">Blob_const</a>(&amp;PAYLOAD, 1), sys_err_code) == 1;</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>  <span class="keywordflow">if</span> (sys_err_code || (!ok))</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span>  {</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>    FLOW_LOG_SET_CONTEXT(logger_ptr, Log_component::S_UTIL);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span> </div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>    FLOW_LOG_FATAL(<span class="stringliteral">&quot;Pipe sync-write failed; this should never happen.  Details follow.&quot;</span>);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>    FLOW_ERROR_SYS_ERROR_LOG_FATAL();</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>    assert(<span class="keyword">false</span> &amp;&amp; <span class="stringliteral">&quot;Pipe-write bug?&quot;</span>); std::abort();</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>  }</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>} <span class="comment">// pipe_produce()</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span> </div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#a814272e555c0592b0caf92b7bc3d64b3">   96</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a814272e555c0592b0caf92b7bc3d64b3">pipe_consume</a>(flow::log::Logger* logger_ptr, <a class="code hl_typedef" href="namespaceipc_1_1util.html#aaf368acf8243bb25de3eef4e836c15de">Pipe_reader</a>* pipe)</div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>{</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span>  <span class="keyword">using </span><a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">util::Blob_mutable</a>;</div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span> </div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>  <span class="comment">// @todo See similar thing in pipe_produce().</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span> </div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>  uint8_t payload;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span> </div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> sys_err_code;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> ok = pipe-&gt;read_some(<a class="code hl_typedef" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">Blob_mutable</a>(&amp;payload, 1), sys_err_code) == 1;</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>  <span class="keywordflow">if</span> (sys_err_code || (!ok))</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>  {</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span>    FLOW_LOG_SET_CONTEXT(logger_ptr, Log_component::S_UTIL);</div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span> </div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno">  111</span>    FLOW_LOG_FATAL(<span class="stringliteral">&quot;Pipe sync-read failed; this should never happen.  Details follow.&quot;</span>);</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>    FLOW_ERROR_SYS_ERROR_LOG_FATAL();</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>    assert(<span class="keyword">false</span> &amp;&amp; <span class="stringliteral">&quot;Pipe-read bug?&quot;</span>); std::abort();</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>  }</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>} <span class="comment">// pipe_consume()</span></div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span> </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">  119</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">remove_persistent_shm_pool</a>(flow::log::Logger* logger_ptr, <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; pool_name, <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* err_code)</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span>{</div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span>  <span class="keyword">using </span>bipc::shared_memory_object;</div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span>  <span class="keyword">using </span>boost::system::system_category;</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span>  <span class="keywordflow">if</span> (flow::error::exec_void_and_throw_on_error</div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span>        ([&amp;](<a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>* actual_err_code)</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span>           { <a class="code hl_function" href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">remove_persistent_shm_pool</a>(logger_ptr, pool_name, actual_err_code); },</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span>         err_code, <span class="stringliteral">&quot;remove_persistent_shm_pool()&quot;</span>))</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span>  {</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span>  }</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span>  <span class="comment">// else</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span> </div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>  FLOW_LOG_SET_CONTEXT(logger_ptr, Log_component::S_UTIL);</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span>  FLOW_LOG_INFO(<span class="stringliteral">&quot;SHM pool [&quot;</span> &lt;&lt; pool_name &lt;&lt; <span class="stringliteral">&quot;]: Removing persistent SHM pool if possible.&quot;</span>);</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>  <span class="keyword">const</span> <span class="keywordtype">bool</span> ok = shared_memory_object::remove(pool_name.<a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a0bccc73c9c5b4f3b784a1e57cdc5c910">native_str</a>()); <span class="comment">// Does not throw.</span></div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span> </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>  <span class="keywordflow">if</span> (ok)</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>  {</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>    err_code-&gt;clear();</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>    <span class="keywordflow">return</span>;</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>  }</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span>  <span class="comment">/* smo::remove() is strangely gimped -- though I believe so are the other kernel-persistent remove()s</span></div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span><span class="comment">   * throughout bipc -- it does not throw and merely returns true or false and no code.  Odd, since there can</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment">   * be at least a couple of reasons one would fail to delete....  However, in POSIX, the Boost 1.78 source code</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">   * shows that smo::remove() calls shared_memory_object::remove() which calls some internal</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment">   * ipcdetail::delete_file() which calls... drumroll... freakin&#39; ::unlink(const char*).  Hence we haxor: */</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="preprocessor">#ifndef FLOW_OS_LINUX </span><span class="comment">// @todo Should maybe check Boost version or something too?</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>  <span class="keyword">static_assert</span>(<span class="keyword">false</span>, <span class="stringliteral">&quot;Code in remove_persistent_shm_pool() relies on Boost invoking Linux unlink() with errno.&quot;</span>);</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>  <span class="keyword">const</span> <span class="keyword">auto</span>&amp; sys_err_code = *err_code = <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>(errno, system_category());</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span>  FLOW_ERROR_SYS_ERROR_LOG_WARNING();</div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span>} <span class="comment">// remove_persistent_shm_pool()</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span> </div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span>} <span class="comment">// namespace ipc::util</span></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html">ipc::util::Shared_name</a></div><div class="ttdoc">String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent entity fr...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00241">shared_name.hpp:242</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a0bccc73c9c5b4f3b784a1e57cdc5c910"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a0bccc73c9c5b4f3b784a1e57cdc5c910">ipc::util::Shared_name::native_str</a></div><div class="ttdeci">const char * native_str() const</div><div class="ttdoc">Returns (sans copying) pointer to NUL-terminated wrapped name string, suitable to pass into sys calls...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8cpp_source.html#l00145">shared_name.cpp:145</a></div></div>
<div class="ttc" id="adetail_2util__fwd_8hpp_html"><div class="ttname"><a href="detail_2util__fwd_8hpp.html">util_fwd.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html"><div class="ttname"><a href="namespaceipc_1_1util.html">ipc::util</a></div><div class="ttdoc">Flow-IPC module containing miscellaneous general-use facilities that ubiquitously used by ~all Flow-I...</div><div class="ttdef"><b>Definition:</b> <a href="default__init__allocator_8hpp_source.html#l00023">default_init_allocator.hpp:24</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a1b398ae730d1e6040687cb2397115152"><div class="ttname"><a href="namespaceipc_1_1util.html#a1b398ae730d1e6040687cb2397115152">ipc::util::Permissions</a></div><div class="ttdeci">bipc::permissions Permissions</div><div class="ttdoc">Short-hand for Unix (POSIX) permissions class.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00161">util_fwd.hpp:161</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a1cdc0a8d761170faa844c49d37c522ff"><div class="ttname"><a href="namespaceipc_1_1util.html#a1cdc0a8d761170faa844c49d37c522ff">ipc::util::remove_persistent_shm_pool</a></div><div class="ttdeci">void remove_persistent_shm_pool(flow::log::Logger *logger_ptr, const Shared_name &amp;pool_name, Error_code *err_code)</div><div class="ttdoc">Equivalent to shm::classic::Pool_arena::remove_persistent().</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00119">util.cpp:119</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf"><div class="ttname"><a href="namespaceipc_1_1util.html#a2ec0bfdddb41a1ef0403e4bb8967705da6fba12db09e5bebfaa04f6372c41c2cf">ipc::util::Permissions_level::S_END_SENTINEL</a></div><div class="ttdeci">@ S_END_SENTINEL</div><div class="ttdoc">Sentinel: not a valid value. May be used to, e.g., size an array&lt;&gt; mapping from Permissions_level.</div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a5429c6225cc9a271ad8c0041d99c236b"><div class="ttname"><a href="namespaceipc_1_1util.html#a5429c6225cc9a271ad8c0041d99c236b">ipc::util::pipe_produce</a></div><div class="ttdeci">void pipe_produce(flow::log::Logger *logger_ptr, Pipe_writer *pipe)</div><div class="ttdoc">Writes a byte to the given pipe writer.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00067">util.cpp:67</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a5716a13eb4de32e516ca257e025d8c20"><div class="ttname"><a href="namespaceipc_1_1util.html#a5716a13eb4de32e516ca257e025d8c20">ipc::util::SHARED_RESOURCE_PERMISSIONS_LVL_MAP</a></div><div class="ttdeci">const boost::array&lt; Permissions, size_t(Permissions_level::S_END_SENTINEL)&gt; SHARED_RESOURCE_PERMISSIONS_LVL_MAP</div><div class="ttdoc">Maps general Permissions_level specifier to low-level Permissions value, when the underlying resource...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00033">util.cpp:34</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a6cb62ae434900f3a8915b33ec5d61a96"><div class="ttname"><a href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96">ipc::util::Blob_mutable</a></div><div class="ttdeci">boost::asio::mutable_buffer Blob_mutable</div><div class="ttdoc">Short-hand for an mutable blob somewhere in memory, stored as exactly a void* and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00140">util_fwd.hpp:140</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a814272e555c0592b0caf92b7bc3d64b3"><div class="ttname"><a href="namespaceipc_1_1util.html#a814272e555c0592b0caf92b7bc3d64b3">ipc::util::pipe_consume</a></div><div class="ttdeci">void pipe_consume(flow::log::Logger *logger_ptr, Pipe_reader *pipe)</div><div class="ttdoc">Reads a byte via the given pipe reader.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00096">util.cpp:96</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_a844d5ca9c17b672644fc8d9dbe758db0"><div class="ttname"><a href="namespaceipc_1_1util.html#a844d5ca9c17b672644fc8d9dbe758db0">ipc::util::Pipe_writer</a></div><div class="ttdeci">boost::asio::writable_pipe Pipe_writer</div><div class="ttdoc">Short-hand for anonymous pipe write end.</div><div class="ttdef"><b>Definition:</b> <a href="detail_2util__fwd_8hpp_source.html#l00032">util_fwd.hpp:32</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_aa74a8b46a5b38021c662a0b3bdfb46bf"><div class="ttname"><a href="namespaceipc_1_1util.html#aa74a8b46a5b38021c662a0b3bdfb46bf">ipc::util::PRODUCER_CONSUMER_RESOURCE_PERMISSIONS_LVL_MAP</a></div><div class="ttdeci">const boost::array&lt; Permissions, size_t(Permissions_level::S_END_SENTINEL)&gt; PRODUCER_CONSUMER_RESOURCE_PERMISSIONS_LVL_MAP</div><div class="ttdoc">Maps general Permissions_level specifier to low-level Permissions value, when the underlying resource...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00041">util.cpp:42</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_aaaa1fe31f8d77f78345dec8fc95e9882"><div class="ttname"><a href="namespaceipc_1_1util.html#aaaa1fe31f8d77f78345dec8fc95e9882">ipc::util::IPC_KERNEL_PERSISTENT_RUN_DIR</a></div><div class="ttdeci">const fs::path IPC_KERNEL_PERSISTENT_RUN_DIR</div><div class="ttdoc">Absolute path to the directory (without trailing separator) in the file system where kernel-persisten...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00063">util.cpp:63</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_aaf368acf8243bb25de3eef4e836c15de"><div class="ttname"><a href="namespaceipc_1_1util.html#aaf368acf8243bb25de3eef4e836c15de">ipc::util::Pipe_reader</a></div><div class="ttdeci">boost::asio::readable_pipe Pipe_reader</div><div class="ttdoc">Short-hand for anonymous pipe read end.</div><div class="ttdef"><b>Definition:</b> <a href="detail_2util__fwd_8hpp_source.html#l00035">util_fwd.hpp:35</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ae0be7edba7e30ffa3f8b742af621f2ab"><div class="ttname"><a href="namespaceipc_1_1util.html#ae0be7edba7e30ffa3f8b742af621f2ab">ipc::util::Blob_const</a></div><div class="ttdeci">boost::asio::const_buffer Blob_const</div><div class="ttdoc">Short-hand for an immutable blob somewhere in memory, stored as exactly a void const * and a size_t.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00134">util_fwd.hpp:134</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="ashared__name_8hpp_html"><div class="ttname"><a href="shared__name_8hpp.html">shared_name.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu May 2 2024 23:56:38 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
